Purchasing price schedules are pricing groups that you can assign to one or more vendors. Discount items by assigning a vendor to a price schedule associated with a price list that contains different discounts for various items. Or define a price schedule with a 10% discount off all items and assign that price schedule to the vendor. See Price schedules — Purchasing for more information.
Returns a collection with a key, ID, and link for each purchasing price schedule. This operation is mostly for use in testing; use query to find objects that meet certain criteria and specify the properties that are returned.
Subscription | Purchasing |
---|---|
Configuration | null |
User type | Business, Project Manager, Employee, Warehouse |
Permissions | List, View Price Schedules |
OK
Bad Request
{- "ia::result": [
- {
- "key": "3",
- "id": "Robotic Price Schedule",
- "href": "/objects/purchasing/price-schedule/3"
}, - {
- "key": "5",
- "id": "Acme Price Schedule",
- "href": "/objects/purchasing/price-schedule/5"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Creates a new purchasing price schedule.
Subscription | Purchasing |
---|---|
Configuration | null |
User type | Business |
Permissions | List, View, Add Price Schedules |
id required | string Name or other unique identifier for the purchasing price schedule. Example: "ColtSched21" | ||||
description | string Description of the purchasing price schedule. Example: "Colt Price Schedule 2021" | ||||
object Associated purchasing price list. | |||||
| |||||
discountPercent | string Discount percentage for all items in the associated price list. A positive value decreases prices; a negative value increases prices. Example: "10" | ||||
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": "Acme Price Schedule",
- "description": "Acme Discount Schedule",
- "discountPercent": "10",
- "status": "active"
}
{- "ia::result": {
- "key": "3",
- "id": "Acme Price Schedule",
- "href": "/objects/purchasing/price-schedule/3"
}, - "ia::meta": {
- "totalCount": 1
}
}
Returns detailed information for a specified purchasing price schedule.
Subscription | Purchasing |
---|---|
Configuration | null |
User type | Business, Project Manager, Employee, Warehouse |
Permissions | List, View Price Schedules |
key required | string System-assigned key for the price schedule. |
OK
Bad Request
{- "ia::result": {
- "key": "3",
- "id": "Acme Price Schedule",
- "description": "Acme Discount Schedule",
- "discountPercent": "10",
- "status": "active",
- "href": "/objects/purchasing/price-schedule/3"
}, - "ia::meta": {
- "totalCount": 1
}
}
Updates an existing purchasing price schedule by setting field values. Any fields not provided remain unchanged.
Subscription | Purchasing |
---|---|
Configuration | null |
User type | Business |
Permissions | List, View, Edit Price Schedules |
key required | string System-assigned key for the price schedule. |
description | string Description of the purchasing price schedule. Example: "Colt Price Schedule 2021" | ||||
object Associated purchasing price list. | |||||
| |||||
discountPercent | string Discount percentage for all items in the associated price list. A positive value decreases prices; a negative value increases prices. Example: "10" | ||||
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
{- "discountPercent": "15"
}
{- "ia::result": {
- "key": "3",
- "id": "Acme Price Schedule",
- "href": "/objects/purchasing/price-schedule/3"
}, - "ia::meta": {
- "totalCount": 1
}
}
Deletes a purchasing price schedule. A price schedule can be deleted if it is no longer in use and it needs to be removed from the system.
Subscription | Purchasing |
---|---|
Configuration | null |
User type | Business |
Permissions | List, View, Delete Price Schedules |
key required | string System-assigned key for the price schedule. |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "A POST request requires a payload",
- "errorId": "REST-1028",
- "additionalInfo": {
- "messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
- "placeholders": {
- "OPERATION": "POST"
}, - "propertySet": { }
}, - "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 0,
- "totalError": 1
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "purchasing/price-schedule" | ||||||||
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
}
}