Printago API
POST /v1/cost-components/search

Search cost components

Search cost components with complex filters

Requires: settings.view

Request Body

SearchQueryDtoCostComponent
fieldsoptional
string
Comma-separated list of fields to return
filteroptional
object
Root filter condition that can be either a logical condition (AND/OR) or field-based condition
andoptional
object[]
All conditions must be true
createdAtoptional
object
Available operators for filtering field values
betweenoptional
any[]
Field value is between two values (inclusive)
containsoptional
string
Field value contains the specified substring (case-insensitive)
endsWithoptional
string
Field value ends with the specified string (case-insensitive)
eqoptional
string | number | boolean
Field value equals the specified value
gtoptional
string | number
Field value is greater than the specified value
gteoptional
string | number
Field value is greater than or equal to the specified value
inoptional
string | number | boolean[]
Field value is one of the specified values
isNulloptional
boolean
Field value is null or not null
ltoptional
string | number
Field value is less than the specified value
lteoptional
string | number
Field value is less than or equal to the specified value
neoptional
string | number | boolean
Field value does not equal the specified value
notInoptional
string | number | boolean[]
Field value is not one of the specified values
startsWithoptional
string
Field value starts with the specified string (case-insensitive)
descriptionoptional
object
Available operators for filtering field values
betweenoptional
any[]
Field value is between two values (inclusive)
containsoptional
string
Field value contains the specified substring (case-insensitive)
endsWithoptional
string
Field value ends with the specified string (case-insensitive)
eqoptional
string | number | boolean
Field value equals the specified value
gtoptional
string | number
Field value is greater than the specified value
gteoptional
string | number
Field value is greater than or equal to the specified value
inoptional
string | number | boolean[]
Field value is one of the specified values
isNulloptional
boolean
Field value is null or not null
ltoptional
string | number
Field value is less than the specified value
lteoptional
string | number
Field value is less than or equal to the specified value
neoptional
string | number | boolean
Field value does not equal the specified value
notInoptional
string | number | boolean[]
Field value is not one of the specified values
startsWithoptional
string
Field value starts with the specified string (case-insensitive)
idoptional
object
Available operators for filtering field values
betweenoptional
any[]
Field value is between two values (inclusive)
containsoptional
string
Field value contains the specified substring (case-insensitive)
endsWithoptional
string
Field value ends with the specified string (case-insensitive)
eqoptional
string | number | boolean
Field value equals the specified value
gtoptional
string | number
Field value is greater than the specified value
gteoptional
string | number
Field value is greater than or equal to the specified value
inoptional
string | number | boolean[]
Field value is one of the specified values
isNulloptional
boolean
Field value is null or not null
ltoptional
string | number
Field value is less than the specified value
lteoptional
string | number
Field value is less than or equal to the specified value
neoptional
string | number | boolean
Field value does not equal the specified value
notInoptional
string | number | boolean[]
Field value is not one of the specified values
startsWithoptional
string
Field value starts with the specified string (case-insensitive)
nameoptional
object
Available operators for filtering field values
betweenoptional
any[]
Field value is between two values (inclusive)
containsoptional
string
Field value contains the specified substring (case-insensitive)
endsWithoptional
string
Field value ends with the specified string (case-insensitive)
eqoptional
string | number | boolean
Field value equals the specified value
gtoptional
string | number
Field value is greater than the specified value
gteoptional
string | number
Field value is greater than or equal to the specified value
inoptional
string | number | boolean[]
Field value is one of the specified values
isNulloptional
boolean
Field value is null or not null
ltoptional
string | number
Field value is less than the specified value
lteoptional
string | number
Field value is less than or equal to the specified value
neoptional
string | number | boolean
Field value does not equal the specified value
notInoptional
string | number | boolean[]
Field value is not one of the specified values
startsWithoptional
string
Field value starts with the specified string (case-insensitive)
oroptional
object[]
At least one condition must be true
rateoptional
object
Available operators for filtering field values
betweenoptional
any[]
Field value is between two values (inclusive)
containsoptional
string
Field value contains the specified substring (case-insensitive)
endsWithoptional
string
Field value ends with the specified string (case-insensitive)
eqoptional
string | number | boolean
Field value equals the specified value
gtoptional
string | number
Field value is greater than the specified value
gteoptional
string | number
Field value is greater than or equal to the specified value
inoptional
string | number | boolean[]
Field value is one of the specified values
isNulloptional
boolean
Field value is null or not null
ltoptional
string | number
Field value is less than the specified value
lteoptional
string | number
Field value is less than or equal to the specified value
neoptional
string | number | boolean
Field value does not equal the specified value
notInoptional
string | number | boolean[]
Field value is not one of the specified values
startsWithoptional
string
Field value starts with the specified string (case-insensitive)
storeIdoptional
object
Available operators for filtering field values
betweenoptional
any[]
Field value is between two values (inclusive)
containsoptional
string
Field value contains the specified substring (case-insensitive)
endsWithoptional
string
Field value ends with the specified string (case-insensitive)
eqoptional
string | number | boolean
Field value equals the specified value
gtoptional
string | number
Field value is greater than the specified value
gteoptional
string | number
Field value is greater than or equal to the specified value
inoptional
string | number | boolean[]
Field value is one of the specified values
isNulloptional
boolean
Field value is null or not null
ltoptional
string | number
Field value is less than the specified value
lteoptional
string | number
Field value is less than or equal to the specified value
neoptional
string | number | boolean
Field value does not equal the specified value
notInoptional
string | number | boolean[]
Field value is not one of the specified values
startsWithoptional
string
Field value starts with the specified string (case-insensitive)
typeoptional
object
Available operators for filtering field values
betweenoptional
any[]
Field value is between two values (inclusive)
containsoptional
string
Field value contains the specified substring (case-insensitive)
endsWithoptional
string
Field value ends with the specified string (case-insensitive)
eqoptional
string | number | boolean
Field value equals the specified value
gtoptional
string | number
Field value is greater than the specified value
gteoptional
string | number
Field value is greater than or equal to the specified value
inoptional
string | number | boolean[]
Field value is one of the specified values
isNulloptional
boolean
Field value is null or not null
ltoptional
string | number
Field value is less than the specified value
lteoptional
string | number
Field value is less than or equal to the specified value
neoptional
string | number | boolean
Field value does not equal the specified value
notInoptional
string | number | boolean[]
Field value is not one of the specified values
startsWithoptional
string
Field value starts with the specified string (case-insensitive)
unitoptional
object
Available operators for filtering field values
betweenoptional
any[]
Field value is between two values (inclusive)
containsoptional
string
Field value contains the specified substring (case-insensitive)
endsWithoptional
string
Field value ends with the specified string (case-insensitive)
eqoptional
string | number | boolean
Field value equals the specified value
gtoptional
string | number
Field value is greater than the specified value
gteoptional
string | number
Field value is greater than or equal to the specified value
inoptional
string | number | boolean[]
Field value is one of the specified values
isNulloptional
boolean
Field value is null or not null
ltoptional
string | number
Field value is less than the specified value
lteoptional
string | number
Field value is less than or equal to the specified value
neoptional
string | number | boolean
Field value does not equal the specified value
notInoptional
string | number | boolean[]
Field value is not one of the specified values
startsWithoptional
string
Field value starts with the specified string (case-insensitive)
updatedAtoptional
object
Available operators for filtering field values
betweenoptional
any[]
Field value is between two values (inclusive)
containsoptional
string
Field value contains the specified substring (case-insensitive)
endsWithoptional
string
Field value ends with the specified string (case-insensitive)
eqoptional
string | number | boolean
Field value equals the specified value
gtoptional
string | number
Field value is greater than the specified value
gteoptional
string | number
Field value is greater than or equal to the specified value
inoptional
string | number | boolean[]
Field value is one of the specified values
isNulloptional
boolean
Field value is null or not null
ltoptional
string | number
Field value is less than the specified value
lteoptional
string | number
Field value is less than or equal to the specified value
neoptional
string | number | boolean
Field value does not equal the specified value
notInoptional
string | number | boolean[]
Field value is not one of the specified values
startsWithoptional
string
Field value starts with the specified string (case-insensitive)
hintsoptional
boolean
If true, returns AI-friendly hints about available actions. Implies meta=true.
includeoptional
string
Comma-separated list of relations to include (max 4, max 2 levels deep). Example: "linkedParts,linkedParts.part,folder"
limitoptional
number
Maximum number of results to return (default: 100, max: 1000)
min: 1max: 1000
metaoptional
boolean
If true, returns response with metadata (total, count, hasMore, etc.)
offsetoptional
number
Number of results to skip for pagination
min: 0
sortoptional
string
Sort specification in format "field:asc,field2:desc"

Example Request

application/json 
{
  "filter": {
    "and": [],
    "or": [],
    "id": {
      "contains": "string",
      "startsWith": "string",
      "endsWith": "string",
      "in": [],
      "notIn": [],
      "isNull": true,
      "between": []
    },
    "name": {
      "contains": "string",
      "startsWith": "string",
      "endsWith": "string",
      "in": [],
      "notIn": [],
      "isNull": true,
      "between": []
    },
    "unit": {
      "contains": "string",
      "startsWith": "string",
      "endsWith": "string",
      "in": [],
      "notIn": [],
      "isNull": true,
      "between": []
    },
    "rate": {
      "contains": "string",
      "startsWith": "string",
      "endsWith": "string",
      "in": [],
      "notIn": [],
      "isNull": true,
      "between": []
    },
    "type": {
      "contains": "string",
      "startsWith": "string",
      "endsWith": "string",
      "in": [],
      "notIn": [],
      "isNull": true,
      "between": []
    },
    "description": {
      "contains": "string",
      "startsWith": "string",
      "endsWith": "string",
      "in": [],
      "notIn": [],
      "isNull": true,
      "between": []
    },
    "storeId": {
      "contains": "string",
      "startsWith": "string",
      "endsWith": "string",
      "in": [],
      "notIn": [],
      "isNull": true,
      "between": []
    },
    "createdAt": {
      "contains": "string",
      "startsWith": "string",
      "endsWith": "string",
      "in": [],
      "notIn": [],
      "isNull": true,
      "between": []
    },
    "updatedAt": {
      "contains": "string",
      "startsWith": "string",
      "endsWith": "string",
      "in": [],
      "notIn": [],
      "isNull": true,
      "between": []
    }
  },
  "sort": "string",
  "limit": 1,
  "offset": 0,
  "fields": "string",
  "include": "string",
  "meta": true,
  "hints": true
}

Response Schema

SearchResponse
datarequired
Record<string, any>[]
Array of matching entities
metarequired
object
Pagination and result metadata
countrequired
number
Number of records returned in this response
executionTimerequired
number
Query execution time in milliseconds
hasMorerequired
boolean
Whether there are more records available
limitrequired
number
Maximum number of records requested
offsetrequired
number
Number of records skipped
totalrequired
number
Total number of matching records (before pagination)

Example Response

201 OK — application/json 
{
  "data": [
    {}
  ],
  "meta": {
    "total": 1,
    "count": 1,
    "offset": 1,
    "limit": 1,
    "hasMore": true,
    "executionTime": 1
  }
}