Project statuses let you track the progress of projects through different states. You can also disable (prevent) certain types of transactions from occurring in specific states, such as not allowing timesheet entries when a project is in a "Not Started" state.
Returns up to 100 object references from the collection with a key, ID, and link for each project status. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Subscription | Projects Basic Project Tracking and General Ledger (enable the Projects dimension) |
---|---|
User type | Business, Employee, Project Manager |
Permissions | List Project Status |
OK
Bad Request
{- "ia::result": [
- {
- "key": "100",
- "id": "In Progress",
- "href": "/objects/projects/project-status/100"
}, - {
- "key": "101",
- "id": "Completed",
- "href": "/objects/projects/project-status/101"
}, - {
- "key": "102",
- "id": "Started",
- "href": "/objects/projects/project-status/102"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 5,
- "next": 0,
- "previous": 0
}
}
Creates a new project status.
Subscription | Projects Basic Project Tracking and General Ledger (enable the Projects dimension) |
---|---|
User type | Business, Project Manager |
Permissions | Add Project Status |
Project status to create
id required | string User-specified name for the project status; used to categorize and report on projects- Same value as Example: "In Progress" |
description | string or null A brief description of the purpose of the project status. Example: "In progress" |
disableTimesheetEntry | boolean Default: false Indicates whether timesheet entries are allowed for projects with this status. Example: false |
disableExpenseEntry | boolean Default: false Indicates whether expense entries are allowed for projects with this status. Example: false |
disablePurchasingAPEntry | boolean Default: false Indicates whether AP/PO entries are allowed for projects with this status. Example: false |
disableGenerateInvoice | boolean Default: false Indicates whether invoices can be generated for projects with this status. Example: false |
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" |
Created
Bad Request
{- "id": "In Progress",
- "description": "Current status",
- "disableTimesheetEntry": false,
- "disableExpenseEntry": false,
- "disablePurchasingAPEntry": false,
- "disableGenerateInvoice": false,
- "status": "active"
}
{- "ia::result": {
- "key": "1",
- "id": "In Progress",
- "href": "/objects/projects/project-status/1"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified project status.
Subscription | Projects Basic Project Tracking and General Ledger (enable the Projects dimension) |
---|---|
User type | Business, Employee, Project Manager |
Permissions | View Project Status |
key required | string System-assigned key for the project status. Example: 1038 |
OK
Bad Request
{- "ia::result": {
- "key": "1",
- "id": "In Progress",
- "description": "In progress",
- "disableTimesheetEntry": false,
- "disableExpenseEntry": false,
- "disablePurchasingAPEntry": false,
- "disableGenerateInvoice": false,
- "status": "active",
- "audit": {
- "createdDateTime": "2022-04-01T16:20:00Z",
- "modifiedDateTime": "2022-04-01T16:20:00Z",
- "createdBy": "1",
- "modifiedBy": "95"
}, - "href": "/objects/projects/project-status/1"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing project status by setting field values. Any fields not provided remain unchanged.
Subscription | Projects Basic Project Tracking and General Ledger (enable the Projects dimension) |
---|---|
User type | Business, Project Manager |
Permissions | Edit Project Status |
key required | string System-assigned key for the project status. Example: 1038 |
description | string or null A brief description of the purpose of the project status. Example: "In progress" |
disableTimesheetEntry | boolean Default: false Indicates whether timesheet entries are allowed for projects with this status. Example: false |
disableExpenseEntry | boolean Default: false Indicates whether expense entries are allowed for projects with this status. Example: false |
disablePurchasingAPEntry | boolean Default: false Indicates whether AP/PO entries are allowed for projects with this status. Example: false |
disableGenerateInvoice | boolean Default: false Indicates whether invoices can be generated for projects with this status. Example: false |
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" |
OK
Bad Request
{- "disableTimesheetEntry": true
}
{- "ia::result": {
- "key": "1",
- "id": "In Progress",
- "href": "/objects/projects/project-status/1"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes a project status.
Subscription | Projects Basic Project Tracking and General Ledger (enable the Projects dimension) |
---|---|
User type | Business, Project Manager |
Permissions | Delete Project Status |
key required | string System-assigned key for the project status. Example: 1038 |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "Payload contains errors",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "errorId": "REST-1064",
- "additionalInfo": {
- "messageId": "IA.PAYLOAD_CONTAINS_ERRORS",
- "placeholders": { },
- "propertySet": { }
}, - "details": [
- {
- "code": "invalidRequest",
- "message": "/testDate is not a valid field",
- "errorId": "REST-1043",
- "target": "/testDate",
- "additionalInfo": {
- "messageId": "IA.NOT_A_VALID_FIELD",
- "placeholders": {
- "FIELD": "/testDate"
}, - "propertySet": { }
}
}
]
}, - "ia::meta": {
- "totalCount": 3,
- "totalSuccess": 2,
- "totalError": 1
}
}, - "ia::error": {
- "code": "invalidRequest",
- "message": "Malformed URL",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "details": [
- {
- "code": "invalidRequest",
- "message": "The content type is not valid",
- "correction": "TODO"
}
]
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "projects/project-status" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
Example: ["key","id","max:vendor.creditLimit"] | ||||||||
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object) Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}] | |||||||||
Array Any of: Field value must be equal to this specified value. For date fields, you can use these macro values that are relative to the current date or the
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
Array of objects Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order. Example: [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}] | |||||||||
Array
| |||||||||
start | integer First record of the result set to include in the response. Example: 1 | ||||||||
size | integer Number of records to include in the response. Example: 100 |
OK
Bad Request
{- "object": "accounts-payable/vendor",
- "fields": [
- "id",
- "name",
- "status",
- "href"
], - "filters": [
- {
- "$eq": {
- "status": "active"
}
}, - {
- "$eq": {
- "billingType": "openItem"
}
}
], - "filterExpression": "1 and 2",
- "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "id": "Vend-00002",
- "name": "Test vendor",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/85"
}, - {
- "id": "VEND-00010",
- "name": "Design Works",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/111"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}