Proposals

Retrieve proposal categories

Returns proposal categories for the specified proposal ID. <br />Note: A proposal category represents a specific section in the proposal form. It can contain proposal costs information, for example, materials, installation labor, freight, etc.; or it can hold a question with answers configured for the proposal form. <br />Supports filtering and sorting in the response. • $expand: Not supported for this method. • $select: Not supported for this method. • $filter: Filter a collection of resources addressed by a request URL. For example, you can filter the proposal data to return only material costs Name eq 'Materials'. • $orderby: Order proposal categories by the specified property in the response. For example, you can order by name in ascending order Name asc or in descending order Name desc. • $top: Return the specified number of proposal categories in the response. • $skip: Skip the specified number of proposal categories in the response. • $count: Include the count of the proposal categories in the response.

get/odata/proposals({proposalId})/Service.Categories()

Request

Base URL
https://sb2api.servicechannel.com/v3
Auth
OAuth 2
Authorization codehttps://sb2login.servicechannel.com/oauth/authorize
Token URLhttps://sb2login.servicechannel.com/oauth/token
TypeScript
https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/odata/proposals(:proposalId)/Service.Categories()/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

proposalIdinteger required

Unique numeric identifier of the proposal.

Query parameters

$expandstring

Expand a navigation property.

$selectstring

Select a set of properties to return.

$filterstring

Filter a collection of resources addressed by a request URL.

$orderbystring

Order resources by the specified property in the response.

$topinteger

Return the specified number of items in the response.

$skipinteger

Skip the specified number of items in the response.

$countboolean

Include the count of the matching resources in the response.

Response

Proposal categories are in the response.

IsLockedboolean

Controls the visibility of the category section, for example, Materials, Installation Labor, in the proposal form. Possible values: • true: The section (category) is hidden from the user interface. • false: The section (category) is visible in the user interface.

DefaultHideDetailsboolean

Determines whether the category displays a standard template or extended rows. Possible values: • true: Shows the default template without additional rows. • false: Displays extended rows based on the template configuration.

Descriptionstring

No longer in use.

IsActiveboolean

Shows whether the category is active.

SortOrderinteger

Predefined order of appearance for a category.

Idinteger

Unique numeric identifier of the proposal category.

Namestring

Type of proposal categories, for example, Materials, Installation Labor, Non-Installation Expenses, etc.

TotalCostnumber double

Subtotal for the specific cost type, for example, materials.

Changes

No recorded changes to this operation across all 1 revision of this API.