Project Estimate Types
- Get Project Estimate Type Object Definition
- List Project Estimate Types
- List Project Estimate Types (Legacy)
- Get Project Estimate Type
- Get Project Estimate Type by Name
- Create Project Estimate Type
- Update Project Estimate Type
- Delete Delete Project Estimate Type
Project estimate types categorize project estimates for reporting purposes and for filtering which project estimate entries post to the GL.
You specify a project estimate type when creating project estimates.
Get Project Estimate Type Object Definition
lookup
List all the fields and relationships for the project estimate type object:
<lookup>
<object>PJESTIMATETYPE</object>
</lookup>Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| object | Required | string | Use PJESTIMATETYPE |
| docparid | Optional | string | Used to indicate the document type, such as Inventory Transfer, Sales Order, Purchase Order and so forth . You must use this to take advantage of any custom fields on the specified document type. |
List Project Estimate Types
query
List the name, record number, and selected workflow types for each project estimate type:
<query>
<object>PJESTIMATETYPE</object>
<select>
<field>NAME</field>
<field>RECORDNO</field>
<field>SELECTEDWFTYPES</field>
</select>
</query> Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| object | Required | string | Use PJESTIMATETYPE |
| select | Required | sequence | One or more field names and an optional aggregate function such as count or sum. Returning all fields is not supported. |
| filter | Optional | object | Query filter expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL). |
| orderby | Optional | object | Provide an order element with a field name and choose an ascending or descending sort order, for example: <order> <field>RECORDNO</field> <descending/> </order> |
| options | Optional | object | Set the caseinsensitive element to true for a case-insensitive query: <caseinsensitive>true</caseinsensitive> In a multi-entity company, set the showprivate element to true to query data in private entities: <showprivate>true</showprivate> |
| pagesize | Optional | integer | Custom page size between 1 and 2000 items (Default: 100) |
| offset | Optional | integer | Point at which to start indexing into records (Default: 0) |
| docparid | Optional | string | Document type, such as Sales Order, Purchase Order, or Inventory Transfer |
List Project Estimate Types (Legacy)
readByQuery
<readByQuery>
<object>PJESTIMATETYPE</object>
<fields>*</fields>
<query></query>
<pagesize>100</pagesize>
</readByQuery> Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| object | Required | string | Use PJESTIMATETYPE |
| fields | Optional | string | Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value. |
| query | Required | string | SQL-like query based on fields on the object. The following operators are supported: <, >, >=, <=, =, like, not like, in, not in, IS NOT NULL, IS NULL, AND, OR. Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes ('Jane\'s Deli'). Joins are not supported. |
| pagesize | Optional | integer | Custom page size between 1 and 1000 items (Default: 100) |
Get Project Estimate Type
read
<read>
<object>PJESTIMATETYPE</object>
<keys>4</keys>
<fields>*</fields>
</read> Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| object | Required | string | Use PJESTIMATETYPE |
| keys | Required | string | Project estimate type RECORDNO to get |
| fields | Optional | string | Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value. |
Get Project Estimate Type by Name
readByName
<readByName>
<object>PJESTIMATETYPE</object>
<keys>Post all</keys>
<fields>*</fields>
</readByName> Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| object | Required | string | Use PJESTIMATETYPE |
| keys | Required | string | Project estimate type NAME to get |
| fields | Optional | string | Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value. |
Create Project Estimate Type
create
<create>
<PJESTIMATETYPE>
<NAME>Revision</NAME>
<SELECTEDWFTYPES>original#~#revision</SELECTEDWFTYPES>
</PJESTIMATETYPE>
</create>Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| PJESTIMATETYPE | Required | object | Object to create |
PJESTIMATETYPE
| Name | Required | Type | Description |
|---|---|---|---|
| NAME | Required | string | Name of the project estimate type, which must be unique. Use 80 or fewer characters. |
| STATUS | Optional | string | Status. Use active or inactive. |
| SELECTEDWFTYPES | Optional | string | Workflow types. Use original, revision, or forecast. Implode multiple workflow types with #~#, for example, original#~#revision. |
| customfields | Optional | customfield[0…n] | Custom fields |
customfield
| Name | Required | Type | Description |
|---|---|---|---|
| customfieldname | Optional | string | Custom field ID |
| customfieldvalue | Optional | varies | Custom field value. For a multi-pick-list custom field, implode multiple field values with #~#. |
Update Project Estimate Type
update
<create>
<PJESTIMATETYPE>
<NAME>Revision</NAME>
<SELECTEDWFTYPES>revision</SELECTEDWFTYPES>
</PJESTIMATETYPE>
</create> Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| PJESTIMATETYPE | Required | object | Object to update |
PJESTIMATETYPE
| Name | Required | Type | Description |
|---|---|---|---|
| NAME | Optional | string | Name of the project estimate type to update. Required if not providing a record number. |
| RECORDNO | Optional | integer | Record number of the project estimate to update. Required if not providing a name. |
| STATUS | Optional | string | Status. Use active or inactive. |
| SELECTEDWFTYPES | Optional | string | Workflow types. Use original, revision, or forecast. Implode multiple workflow types with #~#, for example, original#~#revision. The values supply are a complete replacement of the existing set. |
| customfields | Optional | customfield[0…n] | Custom fields |
customfield
| Name | Required | Type | Description |
|---|---|---|---|
| customfieldname | Optional | string | Custom field ID |
| customfieldvalue | Optional | varies | Custom field value. For a multi-pick-list custom field, implode multiple field values with #~#. |
Delete Delete Project Estimate Type
delete
<delete>
<object>PJESTIMATETYPE</object>
<keys>3</keys>
</delete>Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| object | Required | string | Use PJESTIMATETYPE |
| keys | Required | string | Project estimate type RECORDNO to delete |