Acumatica API - Endpoint Default 24 200 001 icon

Acumatica API - Endpoint Default 24 200 001

Interact with Acumatica Endpoint Default/24.200.001

Actions478

Vendor Price Worksheet → Get List

AI-generated

Summary

Retrieve a list of Vendor Price Worksheet records from Acumatica, optionally applying various filters to limit the results.

Inputs

  • Created Date Time Filter — Apply a date-time filter on the Created Date Time field with operators such as Equals, After, On or After, Before, and On or Before.
  • Description Filter — Filter by Description text with operators Equals, Contains, or Starts With.
  • Effective Date Filter — Apply a date-time filter on the Effective Date field with typical comparative operators.
  • Expiration Date Filter — Apply a date-time filter on the Expiration Date field with typical comparative operators.
  • Hold Filter — Filter records by the Hold boolean field; only 'Equals' operator is available.
  • Last Modified Date Time Filter — Filter by last modified date-time using standard comparison operators.
  • Overwrite Overlapping Prices Filter — Filter by the Overwrite Overlapping Prices boolean field using the Equals operator.
  • Promotional Filter — Filter by the Promotional boolean field using the Equals operator.
  • Reference Nbr Filter — Filter by Reference Number text with operators Equals, Contains, or Starts With.
  • Status Filter — Filter by Status text with operators Equals, Contains, or Starts With.
  • Custom Filter — Provide an advanced custom OData $filter expression (e.g. CustomerID/value eq 'CUST001') for additional filtering, applied alongside other filters.

Output shape

a list of Vendor Price Worksheet records

Returns filtered records as an array of objects matching the Vendor Price Worksheet schema. Filters are combined into an OData $filter query string. If no filters are provided, returns all accessible Vendor Price Worksheet records. No pagination is declared; the full matching result set is returned in one response.

Examples

Example 1: Retrieve all worksheets created on or after January 1, 2024, with Status containing 'Active'.

Set 'Created Date Time Filter' operator to 'On or After' and value to '2024-01-01T00:00:00'. Set 'Status Filter' operator to 'Contains' and value to 'Active'. Leave other filters empty.

Links

Discussion