Routes
Budgets
New Budget
This request creates a new Budget.
| Parameter | Type | Required | Description |
|---|---|---|---|
| locationID | Int | Required | The ID of the location this budget will belong to. |
| name | String | Required | The title of this budget. |
| awaitingAllowPOEdit | Boolean | Required | When POs belonging to this budget are in the "ready to receive" state, will they be editable? |
| awaitingEmailSend | Boolean | Required | When POs belonging to this budget enter the "ready to receive" state, should the assignee(s) be emailed? |
| awaitingAssignmentType | Enum | Required | What type ('user' or 'team') should we interpret the awaitingAssignment value as? |
| awaitingAssignment | Int or Array of Ints | Required | When POs belonging to this budget enter the "ready to receive" state, who will they be assigned to? If awaitingAssignmentType is 'team' then this cannot be an array, and may only be one number. |
| prEmailSend | Boolean | Required | When PO items are received on POs that belong to this budget in the "ready to receive" or "partially received" states, should we send email notification(s)? |
| prAssignmentType | Enum | Required | What type ('user' or 'team') should we interpret the prAssignment value as? |
| prAssignment | Int or Array of Ints | Required | When bills are generated for PO items on POs that belong to this budget, who should the bills be assigned to? If prAssignmentType is 'team' then this cannot be an array, and may only be one number. |
| defaultBudget | Object | Required | An object containing Boolean flags for global, purchaseRequests, and minPartQtyPOs. Setting any of these flags to true will set the same value for any other budgets at this location to false (we cannot have two default budgets). All properties of this object are required. global: Should this be the default budget for this location? purchaseRequests: When purchase requests are created from tasks, should this be the default budget? minPartQtyPOs: When a PO is automatically created due to part quantity threshold, should this be the default budget? |
post/v2/budgets
Request
- Base URL{{server}}:{{port}}
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Response
New Budget
Changes
No recorded changes to this operation across all 4 revisions of this API.