Price list entries

An inventory 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/inventory-control/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/inventory-control/price-list-entry/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/inventory-control/price-list-entry/2"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "totalSuccess": 2,
    • "totalError": 0
    }
}

Create a price list entry

post/objects/inventory-control/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 inventory price list/schedule.

key
string

System assigned key for the inventory price list.

Example: "1"
id
string <= 20 characters

Unique identifier for the inventory 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"
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/inventory-control/price-list-entry/421"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Get a price list entry

get/objects/inventory-control/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": {
        }
      },
    • "ia::meta": {
      • "totalCount": 1,
      • "totalSuccess": 1,
      • "totalError": 0
      }
    }
}

Update a price list entry

patch/objects/inventory-control/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 inventory price list/schedule.

key
string

System assigned key for the inventory price list.

Example: "1"
id
string <= 20 characters

Unique identifier for the inventory 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/inventory-control/price-list-entry/435"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Delete a price list entry

delete/objects/inventory-control/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

Queries an object for filtered data.

SecurityOAuth2
Request
Request Body schema: application/json
object
string

Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.

Example: "inventory-control/price-list-entry"
fields
Array of strings

List of fields to include in the response. Can be any combination of these:

  • The name of a field in the object that you are querying, such as id.

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:

    • count
    • avg
    • sum
    • min
    • max
  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.

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 has (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 {"$eq":{"status":"active"}} to select objects in which status is equal to "active".

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 asOfDate in filterParameters, if set:

  • today
  • currentWeek
  • currentMonth
  • currentQuarter
  • currentYear
  • yesterday
  • lastWeek
  • priorMonth
  • priorQuarter
  • priorYear

These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.

For example, {"eq":{"postingDate":"priorYear"}}.

object

The field name and value to be compared with object values.

Example: {"status":"active"}
filterExpression
string
Default: "and"

Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.

Shortcuts:

  • and by itself means that all conditions must be true.
  • or by itself means that at least one condition must be true.
Example: "(1 and 2) or 3"
object

Pre-defined filter options.

asOfDate
string <date>

The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".

The current date is used if asOfDate is not set.

Example: "2022-04-01"
includeHierarchyFields
boolean
Default: false

Set to true to include hierarchical structure information with each object in the response.

Example: false
caseSensitiveComparison
boolean
Default: true

Queries are case-sensitive by default. Set to false to ignore case in a query.

Example: true
includePrivate
boolean
Default: false

By default, in a multi-entity company queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.

Example: false
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
property name*
additional property
string
Enum: "asc" "desc"
start
integer

First record of the result set to include in the response.

Example: 1
size
integer

Number of records to include in the result set, 4000 maximum.

Example: 100
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "object": "inventory-control/price-list-entry",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "item.id",
    • "valueType",
    • "value"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "3",
      • "item.id": "DM",
      • "valueType": "actual",
      • "value": "20.00"
      },
    • {
      • "key": "4",
      • "item.id": "PCA",
      • "valueType": "actual",
      • "value": "30.00"
      },
    • {
      • "key": "5",
      • "item.id": "PCCS",
      • "valueType": "actual",
      • "value": "40.00"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}