Price list entries

A purchasing price list entry contains the pricing for a selected item within a selected price list. You can create price list entries for items whose prices are determined based on an amount, a discount or mark up percentage, the quantity sold, and more.

List price list entries

get/objects/purchasing/price-list-entry

Returns a collection with a key, ID, and link for each price list entry.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/purchasing/price-list-entry/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/purchasing/price-list-entry/2"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "totalSuccess": 2,
    • "totalError": 0
    }
}

Create a price list entry

post/objects/purchasing/price-list-entry

Creates a new price list entry.

SecurityOAuth2
Request
Request Body schema: application/json
required
startDate
required
string <date>

Provide the date on which the price becomes effective. You can enter past or future dates.

Example: "2024-01-01"
endDate
required
string <date>

Provide the date on which the price ends. You can enter past or future dates.

Example: "2024-01-01"
value
required
string <decimal-precision-10>

The value you provide depends on the type that you set in the valueType field.

Example: "60.56"
valueType
required
string
Default: "actual"

Value Type

Enum: "actual" "discountPercent" "dollarDiscount" "dollarMarkup" "markupPercent"
Example: "actual"
required
object

Price list associated with the purchasing price list/schedule.

key
string

System assigned key for the purchasing price list.

Example: "1"
id
string <= 20 characters

Unique identifier for the purchase price list.

Example: "Base Price List"
required
object

Price list entry for the item.

key
string

System assigned unique item key.

Example: "89"
id
string

System assigned unique item id.

Example: "Battery"
name
string

Name of the item.

Example: "Battery for Car"
required
object

Provide product line to which this item belongs.

key
string <= 8 characters

System generated product line key

Example: "25"
id
string <= 20 characters

Unique ID for the product line.

Example: "Office_Supplies"
id
string <= 8 characters

Price list entry ID.

Example: "38"
currency
string

Provide the currency in which the price will be evaluated. This field is only applicable to multi-currency companies.

Example: "USD"
minimumQuantity
string <decimal-precision-8>

Use this option if you want to give or get price breaks according to the quantity ordered. With this type of pricing, the system multiplies the transaction quantity by the rate mapped to the quantity range in which the transaction quantity falls.

Example: "1"
maximumQuantity
string <decimal-precision-8>

Use this option if you want to give or get price breaks according to the quantity ordered. With this type of pricing, the system multiplies the transaction quantity by the rate mapped to the quantity range in which the transaction quantity falls.

Example: "100"
isFixedPrice
boolean
Default: "true"

Indicates whether the price is the fixed or final price.

Enum: "false" "true"
Example: "false"
object

If you want to define a project billing rate, you use a combination of employee and item. Intacct will use the price associated with this item/employee combination for applicable timesheets when you generate invoices for time and materials projects.

key
string <= 8 characters

System assigned unique key for the employee.

Example: "25"
id
string

Unique ID of the employee.

Example: "123"
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
{
  • "startDate": "2024-07-01",
  • "endDate": "2024-09-31",
  • "minimumQuantity": "1",
  • "maximumQuantity": "9999999",
  • "value": "1.00000000",
  • "valueType": "actual",
  • "isFixedPrice": "true",
  • "status": "active",
  • "currency": "USD"
}
Response samples
application/json
{
  • "ia::result": {
    • "id": "421",
    • "key": "421",
    • "href": "/objects/purchasing/price-list-entry/421"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Get a price list entry

get/objects/purchasing/price-list-entry/{key}

Returns detailed information for a specified price list entry.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the price list entry.

Example: 99
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "Details of the price list entry": {
    • "value": {
      • "ia::result": {
        }
      }
    }
}

Update a price list entry

patch/objects/purchasing/price-list-entry/{key}

Updates an existing price list entry by setting field values. Any fields not provided remain unchanged.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the price list entry.

Example: 99
Request Body schema: application/json
object

Provide product line to which this item belongs.

key
string <= 8 characters

System generated product line key

Example: "25"
id
string <= 20 characters

Unique ID for the product line.

Example: "Office_Supplies"
currency
string

Provide the currency in which the price will be evaluated. This field is only applicable to multi-currency companies.

Example: "USD"
startDate
string <date>

Provide the date on which the price becomes effective. You can enter past or future dates.

Example: "2024-01-01"
endDate
string <date>

Provide the date on which the price ends. You can enter past or future dates.

Example: "2024-01-01"
minimumQuantity
string <decimal-precision-8>

Use this option if you want to give or get price breaks according to the quantity ordered. With this type of pricing, the system multiplies the transaction quantity by the rate mapped to the quantity range in which the transaction quantity falls.

Example: "1"
maximumQuantity
string <decimal-precision-8>

Use this option if you want to give or get price breaks according to the quantity ordered. With this type of pricing, the system multiplies the transaction quantity by the rate mapped to the quantity range in which the transaction quantity falls.

Example: "100"
value
string <decimal-precision-10>

The value you provide depends on the type that you set in the valueType field.

Example: "60.56"
valueType
string
Default: "actual"

Value Type

Enum: "actual" "discountPercent" "dollarDiscount" "dollarMarkup" "markupPercent"
Example: "actual"
isFixedPrice
boolean
Default: "true"

Indicates whether the price is the fixed or final price.

Enum: "false" "true"
Example: "false"
object

If you want to define a project billing rate, you use a combination of employee and item. Intacct will use the price associated with this item/employee combination for applicable timesheets when you generate invoices for time and materials projects.

key
string <= 8 characters

System assigned unique key for the employee.

Example: "25"
id
string

Unique ID of the employee.

Example: "123"
object

Price list entry for the item.

key
string

System assigned unique item key.

Example: "89"
id
string

System assigned unique item id.

Example: "Battery"
name
string

Name of the item.

Example: "Battery for Car"
object

Price list associated with the purchasing price list/schedule.

key
string

System assigned key for the purchasing price list.

Example: "1"
id
string <= 20 characters

Unique identifier for the purchase price list.

Example: "Base Price List"
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
{
  • "startDate": "2018-02-01"
}
Response samples
application/json
{
  • "ia::result": {
    • "id": "435",
    • "key": "435",
    • "href": "/objects/purchasing/price-list-entry/435"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Delete a price list entry

delete/objects/purchasing/price-list-entry/{key}

Deletes a price list entry.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the price list entry.

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
    }
}

Query price list entries

post/services/core/query

Use the query service to find price list entries that meet certain criteria and to specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

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
    }
}