Price schedules

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.

List price schedules

get/objects/purchasing/price-schedule

Returns a collection with a key, ID, and link for each purchasing price schedule. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "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
    }
}
Create a price schedule
post/objects/purchasing/price-schedule
Creates a new purchasing price schedule.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string
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.


 
key
string
System-assigned key for the purchasing price list.


 
 Example:  "23"
id
string
Unique identifier for the purchasing price list.


 
 Example:  "Purchasing Price list"
discountPercent
string <decimal-precision-2> 
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.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "Acme Price Schedule",
  • "description": "Acme Discount Schedule",
  • "discountPercent": "10",
  • "status": "active"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "3",
    • "id": "Acme Price Schedule",
    • "href": "/objects/purchasing/price-schedule/3"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a price schedule
get/objects/purchasing/price-schedule/{key}
Returns detailed information for a specified purchasing price schedule.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the price schedule.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "3",
    • "id": "Acme Price Schedule",
    • "description": "Acme Discount Schedule",
    • "discountPercent": "10",
    • "status": "active",
    • "href": "/objects/purchasing/price-schedule/3"
    },
  • "audit": {
    • "modifiedBy": "1",
    • "createdDateTime": "2024-10-09T07:42:01Z",
    • "modifiedDateTime": "2024-10-09T07:52:39Z",
    • "createdBy": "1"
    },
  • "entity": {
    • "id": "1",
    • "key": "1",
    • "name": "New Entity"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Update a price schedule
patch/objects/purchasing/price-schedule/{key}
Updates an existing purchasing price schedule by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the price schedule.


 
 Example:  99
Request Body schema: application/json
description
string
Description of the purchasing price schedule.


 
 Example:  "Colt Price Schedule 2021"
object
Associated purchasing price list.


 
key
string
System-assigned key for the purchasing price list.


 
 Example:  "23"
id
string
Unique identifier for the purchasing price list.


 
 Example:  "Purchasing Price list"
discountPercent
string <decimal-precision-2> 
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.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "discountPercent": "15"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "3",
    • "id": "Acme Price Schedule",
    • "href": "/objects/purchasing/price-schedule/3"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a price schedule
delete/objects/purchasing/price-schedule/{key}
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.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the price schedule.


 
 Example:  99
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}