Search Costs

Finds the costs that match the search criteria. Specify at least one search criteria.

Resource Information

Scopesearch_costs
Scope Group(s)costs
App TypeAgency
Authorization TypeAccess token
URI /v4/search/costs?offset={offset}&limit={limit}&fields={fields}&lang={lang}
HTTP MethodPOST
Automation Version(s)7.3.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
defaultAccountdefaultAccount{}NoThe default account associated with the cost.7.3.3
defaultAccount.textstringNoThe localized display text.7.3.2
defaultAccount.valuestringNoThe value for the specified parameter.7.3.2
defaultFactordefaultFactor{}NoThe default cost factor.7.3.3
defaultFactor.textstringNoThe localized display text.7.3.2
defaultFactor.valuestringNoThe value for the specified parameter.7.3.2
descriptionstringNoThe description of the record or item.7.3.3
fixedRatedoubleNoThe fixed cost amount for the cost item.7.3.3
namename{}NoThe full name for the application contact.7.3.3
name.textstringNoThe localized display text.7.3.2
name.valuestringNoThe value for the specified parameter.7.3.2
statusstatus{}NoThe cost item status.7.3.3
status.textstringNoThe localized display text.7.3.2
status.valuestringNoThe value for the specified parameter.7.3.2
subgroupstringNoA grouping of fee items to which the system can ascribe a value.7.3.3
typetype{}No Get All Cost Types The cost type, such as: contract, employee, materials.7.3.3
type.textstringNoThe localized display text.7.3.2
type.valuestringNoThe value for the specified parameter.7.3.2
unitOfMeasureunitOfMeasure{}NoThe unit of measurement for quantifying the cost item.7.3.3
unitOfMeasure.textstringNoThe localized display text.7.3.2
unitOfMeasure.valuestringNoThe value for the specified parameter.7.3.2
unitRatedoubleNoThe unit rate for the cost item.7.3.3
fieldsstringNoComma-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
langStringNoIndicates the language applied.7.3.2
limitlongNoIndicates the number of items that are returned in each page.7.3.2
offsetlongNoIndicates the offset start of each page by the number specified.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{}7.3.3
result.defaultAccountresult.defaultAccount{}The default account associated with the cost.7.3.3
result.defaultAccount.textstringThe localized display text.7.3.2
result.defaultAccount.valuestringThe value for the specified parameter.7.3.2
result.defaultFactorresult.defaultFactor{}The default cost factor.7.3.3
result.defaultFactor.textstringThe localized display text.7.3.2
result.defaultFactor.valuestringThe value for the specified parameter.7.3.2
result.descriptionstringThe description of the record or item.7.3.3
result.fixedRatedoubleThe fixed cost amount for the cost item.7.3.3
result.nameresult.name{}The full name for the application contact.7.3.3
result.name.textstringThe localized display text.7.3.2
result.name.valuestringThe value for the specified parameter.7.3.2
result.statusresult.status{}The cost item status.7.3.3
result.status.textstringThe localized display text.7.3.2
result.status.valuestringThe value for the specified parameter.7.3.2
result.subgroupstringA grouping of fee items to which the system can ascribe a value.7.3.3
result.typeresult.type{}The cost type, such as: contract, employee, materials.7.3.3
result.type.textstringThe localized display text.7.3.2
result.type.valuestringThe value for the specified parameter.7.3.2
result.unitOfMeasureresult.unitOfMeasure{}The unit of measurement for quantifying the cost item.7.3.3
result.unitOfMeasure.textstringThe localized display text.7.3.2
result.unitOfMeasure.valuestringThe value for the specified parameter.7.3.2
result.unitRatedoubleThe unit rate for the cost item.7.3.3
statusintegerThe record status.7.3.3