Finds the costs that match the search criteria. Specify at least one search criteria.
| Scope | search_costs |
| Scope Group(s) | costs |
| App Type | Agency |
| Authorization Type | Access token |
| URI | /v4/search/costs?offset={offset}&limit={limit}&fields={fields}&lang={lang} |
| HTTP Method | POST |
| Automation Version(s) | 7.3.3.2 |
| Field or Parameter | Type | Required | Values | Description | Automation Version |
|---|---|---|---|---|---|
| defaultAccount | defaultAccount{} | No | � | The default account associated with the cost. | 7.3.3 |
| defaultAccount.text | string | No | � | The localized display text. | 7.3.2 |
| defaultAccount.value | string | No | � | The value for the specified parameter. | 7.3.2 |
| defaultFactor | defaultFactor{} | No | � | The default cost factor. | 7.3.3 |
| defaultFactor.text | string | No | � | The localized display text. | 7.3.2 |
| defaultFactor.value | string | No | � | The value for the specified parameter. | 7.3.2 |
| description | string | No | � | The description of the record or item. | 7.3.3 |
| fixedRate | double | No | � | The fixed cost amount for the cost item. | 7.3.3 |
| name | name{} | No | � | The full name for the application contact. | 7.3.3 |
| name.text | string | No | � | The localized display text. | 7.3.2 |
| name.value | string | No | � | The value for the specified parameter. | 7.3.2 |
| status | status{} | No | � | The cost item status. | 7.3.3 |
| status.text | string | No | � | The localized display text. | 7.3.2 |
| status.value | string | No | � | The value for the specified parameter. | 7.3.2 |
| subgroup | string | No | � | A grouping of fee items to which the system can ascribe a value. | 7.3.3 |
| type | type{} | No | Get All Cost Types | The cost type, such as: contract, employee, materials. | 7.3.3 |
| type.text | string | No | � | The localized display text. | 7.3.2 |
| type.value | string | No | � | The value for the specified parameter. | 7.3.2 |
| unitOfMeasure | unitOfMeasure{} | No | � | The unit of measurement for quantifying the cost item. | 7.3.3 |
| unitOfMeasure.text | string | No | � | The localized display text. | 7.3.2 |
| unitOfMeasure.value | string | No | � | The value for the specified parameter. | 7.3.2 |
| unitRate | double | No | � | The unit rate for the cost item. | 7.3.3 |
| fields | string | No | � | Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored. | 7.3.2 |
| lang | String | No | � | Indicates the language applied. | 7.3.2 |
| limit | long | No | � | Indicates the number of items that are returned in each page. | 7.3.2 |
| offset | long | No | � | Indicates the offset start of each page by the number specified. | 7.3.2 |
| Field | Type | Description | Automation Version |
|---|---|---|---|
| result[] | result{} | � | 7.3.3 |
| result.defaultAccount | result.defaultAccount{} | The default account associated with the cost. | 7.3.3 |
| result.defaultAccount.text | string | The localized display text. | 7.3.2 |
| result.defaultAccount.value | string | The value for the specified parameter. | 7.3.2 |
| result.defaultFactor | result.defaultFactor{} | The default cost factor. | 7.3.3 |
| result.defaultFactor.text | string | The localized display text. | 7.3.2 |
| result.defaultFactor.value | string | The value for the specified parameter. | 7.3.2 |
| result.description | string | The description of the record or item. | 7.3.3 |
| result.fixedRate | double | The fixed cost amount for the cost item. | 7.3.3 |
| result.name | result.name{} | The full name for the application contact. | 7.3.3 |
| result.name.text | string | The localized display text. | 7.3.2 |
| result.name.value | string | The value for the specified parameter. | 7.3.2 |
| result.status | result.status{} | The cost item status. | 7.3.3 |
| result.status.text | string | The localized display text. | 7.3.2 |
| result.status.value | string | The value for the specified parameter. | 7.3.2 |
| result.subgroup | string | A grouping of fee items to which the system can ascribe a value. | 7.3.3 |
| result.type | result.type{} | The cost type, such as: contract, employee, materials. | 7.3.3 |
| result.type.text | string | The localized display text. | 7.3.2 |
| result.type.value | string | The value for the specified parameter. | 7.3.2 |
| result.unitOfMeasure | result.unitOfMeasure{} | The unit of measurement for quantifying the cost item. | 7.3.3 |
| result.unitOfMeasure.text | string | The localized display text. | 7.3.2 |
| result.unitOfMeasure.value | string | The value for the specified parameter. | 7.3.2 |
| result.unitRate | double | The unit rate for the cost item. | 7.3.3 |
| status | integer | The record status. | 7.3.3 |